home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_perl.idb / usr / freeware / catman / p_man / cat3 / Pod::Text.Z / Pod::Text
Encoding:
Text File  |  1998-10-28  |  2.0 KB  |  67 lines
  1.  
  2.  
  3.  
  4.      PPPPoooodddd::::::::TTTTeeeexxxxtttt((((3333))))    22223333////JJJJuuuullll////99998888 ((((ppppeeeerrrrllll 5555....000000005555,,,, ppppaaaattttcccchhhh 00002222))))      PPPPoooodddd::::::::TTTTeeeexxxxtttt((((3333))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       Pod::Text - convert POD data to formatted ASCII text
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           use Pod::Text;
  13.  
  14.           pod2text("perlfunc.pod");
  15.  
  16.       Also:
  17.  
  18.           pod2text [B<-a>] [B<->I<width>] < input.pod
  19.  
  20.  
  21.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  22.       Pod::Text is a module    that can convert documentation in the
  23.       POD format (such as can be found throughout the Perl
  24.       distribution)    into formatted ASCII.  Termcap is optionally
  25.       supported for    boldface/underline, and    can enabled via
  26.       $Pod::Text::termcap=1. If termcap has    not been enabled, then
  27.       backspaces will be used to simulate bold and underlined
  28.       text.
  29.  
  30.       A separate _p_o_d_2_t_e_x_t program is included that is primarily a
  31.       wrapper for Pod::Text.
  32.  
  33.       The single function pod2text() can take the optional options
  34.       ----aaaa for an alternative    output format, then a ----_w_i_d_t_h option
  35.       with the max terminal    width, followed    by one or two
  36.       arguments. The first should be the name of a file to read
  37.       the pod from,    or "<&STDIN" to    read from STDIN. A second
  38.       argument, if provided, should    be a filehandle    glob where
  39.       output should    be sent.
  40.  
  41.      AAAAUUUUTTTTHHHHOOOORRRR
  42.       Tom Christiansen <_t_c_h_r_i_s_t@_m_o_x._p_e_r_l._c_o_m>
  43.  
  44.      TTTTOOOODDDDOOOO
  45.       Cleanup work.    The input and output locations need to be more
  46.       flexible, termcap shouldn't be a global variable, and    the
  47.       terminal speed needs to be properly calculated.
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                        (printed 10/23/98)
  64.  
  65.  
  66.  
  67.